Skip to main content

CRM

Detailed description of API:​

Interface currently available for DMS development in:
  • LATAM (Construction Equipment - CE)

Version & Updates​

VersionRevision DateRevision History
1.024th April 2026Initial Release

Objective & Scope​

The purpose of this integration is to enable a standardized set of APIs that allow seamless exchange of CRM-related data between Dealer Management Systems (DMS) and the Enterprise Data System (EDS). The data exchanged through these interfaces supports downstream reporting and analytical use cases.

The scope of this integration includes:

  • Inbound data flow (DMS → EDS)

    • Submission of CRM entities such as Leads and Retail Orders from DMS to EDS

  • Outbound data flow (EDS → DMS)

    • Retrieval of Equipment Wholesale and Status information from EDS to DMS

This integration is implemented through the Digital Enterprise Platform (DEP) and applies to DMS solutions operating within the LATAM Construction Equipment (CE) segment.
EDS acts as the system of record for both publishing and consuming the integrated data.

Objective​

  • Exchange CRM data between DMS and EDS
  • Enable downstream analytics and reporting

Functional Scope​

  • POST Lead API → Send lead data from DMS to EDS
  • POST Retail Order API → Send retail order data from DMS to EDS
  • GET Equipment Wholesale & Status API → Retrieve equipment data from EDS

High-level Integration​

  • DMS sends request to DEP-EXT layer
  • Authentication is validated at DEP
  • Request is forwarded to internal services (DEP-INT)
  • Data processing happens with EDS system
  • Response is returned back to DMS

Key Components​

  • API Gateway / APIM
  • Security (DSA Validation)
  • Authentication Layer
  • Monitoring & Logging

API Format​

  • REST

Authentication​

  • Basic Authentication (UserID & Password)
  • Subscription Key required in HTTP header
  • Credentials configured at Dealer level

Connection Details​

CNHi provides two environments:

  • CERT/UAT
  • Production
EnvironmentURLAPIRequest Type
CERT/UAThttps://{base_url}/latamexternal/services/latam-crmRESTPOST
ProductionTBDRESTPOST

✅ 1. POST Lead API

Description​

This API allows DMS to send Lead information to EDS via DEP.

Request Structure​

FieldDEP NameTypeMandatory
Lead IDLeadIdUUIDYes
Lead SourceLeadSourceEnumYes
BrandBrandEnumYes
Product LineProductLineStringYes
ModelModelStringYes
SegmentSegmentEnumYes
Assigned DealerDealerIdUUIDYes
Lead StatusLeadStatusEnumYes
Loss ReasonLossReasonEnumYes
Routing RuleRoutingRuleStringYes
Reassign CountReassignCountIntegerYes
Owner UserOwnerUserIdUUIDYes
Accepted AtAcceptedAtDatetime (ISO 8601)Yes
First Contact TimeFirstContactTimeIntegerYes
UTM SourceUtmSourceStringYes
UTM MediumUtmMediumStringYes
UTM CampaignUtmCampaignStringYes
Captured AtCapturedAtDatetime (ISO 8601)Yes

Notes​

  • One request represents one lead
  • Supports near real-time ingestion

Sample Request Payload​

Endpoint: /cecrm/lead

{
  "leadId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "leadSource": "string",
  "brand": "string",
  "productLine": "string",
  "model": "string",
  "segment": "string",
  "dealerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "leadStatus": "string",
  "lossReason": "string",
  "routingRule": "string",
  "reassignmentCount": 0,
  "ownerUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "acceptedAt": "2026-06-19T12:09:00.674Z",
  "firstContactTime": 0,
  "utmSource": "string",
  "utmMedium": "string",
  "utmCampaign": "string",
  "capturedAt": "2026-06-19T12:09:00.674Z"
}

✅ 2. POST Retail Order API

Description​

This API allows DMS to send Retail Order data to EDS.

Request Structure​

Post Retail Order API Request Structure​

FieldEDS NameDEP NameFormatRequired (Y/N)Example
IDididUUIDY3fa85f64...
VIN (Chassis)vinvinStringY17 chars
Invoice SeriesinvoiceSeriesinvoiceSeriesStringY1
Invoice NumberinvoiceNumberinvoiceNumberStringY123456
Invoice Date/TimeinvoiceDateTimeinvoiceDateTimeDatetimeYISO 8601
NF-e Access KeyinvoiceNfeAccessKeyinvoiceNfeAccessKeyStringN44 digits
Order NumberorderNumberorderNumberStringY98765
Sell Out FlagsellOutFlagsellOutFlagIntegerY0 or 1
Billing Date/TimebillingDateTimebillingDateTimeDatetimeYISO 8601
Received Date/TimereceivedDateTimereceivedDateTimeDatetimeYISO 8601
Pre-Delivery DatepreDeliveryDateTimepreDeliveryDateTimeDatetimeYISO 8601
Technical DeliverytechnicalDeliveryDateTimetechnicalDeliveryDateTimeDatetimeYISO 8601
Activity CodeactivityCodeactivityCodeIntegerY0
Application CodeapplicationCodeapplicationCodeIntegerY0
Resource CoderesourceCoderesourceCodeIntegerY0
Form of PaymentformOfPaymentformOfPaymentStringYBoleto
Days for PaymentdaysForPaymentdaysForPaymentIntegerY30
Used EquipmentusedEquipmentusedEquipmentIntegerY0 or 1
Seller NamesellerNamesellerNameStringYJoão Silva
Customer IDididUUIDYUUID v4
Customer Document TypedocumentTypedocumentTypeStringYCPF/CNPJ
Customer Document NumberdocumentNumberdocumentNumberStringY000.000...
Customer Zip CodezipCodezipCodeStringY00000-000
Customer CitycitycityStringYContagem
Customer StatestatestateStringYMG
Customer EmailemailemailStringYxxxx@email.com
Item NumberitemNumberitemNumberStringY1
Item CodeitemCodeitemCodeStringYPart number
Item DescriptionitemDescriptionitemDescriptionStringYPeça X
Item AmountitemAmountitemAmountDecimalY1500.00
Dealer CodedealerCodedealerCodeStringYUUID v4
Dealer NamedealerNamedealerNameStringYConcessionário X
Brand CodebrandCodebrandCodeStringY"CS" / "NH"

Notes​

  • One request represents one retail order
  • Supports real-time data push

Sample Request Payload​

Endpoint: /cecrm/retailorder

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "vin": "string",
  "invoiceSeries": "string",
  "invoiceNumber": "string",
  "invoiceDateTime": "2026-06-19T12:09:37.748Z",
  "invoiceNfeAccessKey": "string",
  "orderNumber": "string",
  "sellOutFlag": 0,
  "billingDateTime": "2026-06-19T12:09:37.748Z",
  "receivedDateTime": "2026-06-19T12:09:37.748Z",
  "preDeliveryDateTime": "2026-06-19T12:09:37.748Z",
  "technicalDeliveryDateTime": "2026-06-19T12:09:37.748Z",
  "activityCode": 0,
  "applicationCode": 0,
  "resourceCode": 0,
  "formOfPayment": "string",
  "daysForPayment": 0,
  "usedEquipment": 0,
  "sellerName": "string",
  "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "documentType": "string",
  "documentNumber": "string",
  "zipCode": "string",
  "city": "string",
  "state": "string",
  "email": "string",
  "items": [
    {
      "itemNumber": "string",
      "itemCode": "string",
      "itemDescription": "string",
      "itemAmount": 0
    }
  ],
  "dealerCode": "string",
  "dealerName": "string",
  "brandCode": "string"
}

✅ 3. GET Equipment Wholesale & Status API

Description​

This API allows DMS to retrieve Equipment Wholesale and Status data from EDS.

Key Characteristics​

  • Method: GET
  • Data Type: Daily incremental changes
  • Filters supported:
    • Date
    • GDD Code

Endpoint: /cecrm/getequipmentwholesale

Response Structure​

FieldTypeMandatory
VINString (17 chars)Yes
Aging DaysIntegerYes
BlocksStringYes
ETADateYes
Shipping Window IDStringYes
QuantityIntegerYes
Order StatusEnumYes
Billing StatusEnumYes
Order IDStringYes
Brand/Line/ModelStringYes
Dealer IDUUIDYes
Shipping StatusEnumYes

Notes​

  • Primary identifier: VIN
  • Data returned is daily delta
  • Used for tracking inventory lifecycle

Response Codes​

Status CodeDescription
200Success
400Validation Error
401Unauthorized
404Not Found
500Internal Server Error

Key Integration Points​

  • All APIs are exposed via DEP
  • Authentication handled centrally
  • DSA validation applied before processing
  • Backend systems support batch handling